FED-4419 Migrate builder test to functional test, refactor gold file setup by greglittlefield-wf · Pull Request #998 · Workiva/over_react

greglittlefield-wf · 2026-02-11T00:47:13Z

Motivation

The current over_react_builder_test.dart unit test can't be authored in a way that works with both older and newer analyzer versions.

We already had some workarounds in place for some analyzer versions, added in #982

But with newer analyzer versions, there are even more incompatibilities, such as not being able to depend on build_resolvers, and continuing to maintain these tests in a single over_react version isn't feasible.

Changes

Migrate over_react_builder_test.dart from a unit test to a functional test that runs actual build commands, as opposed to relying on build/build_test_build_resolvers APIs to set up unit tests
Remove tool/update_tests_for_dart_3.sh and related code needed for multi-analyzer-version support of existing tests
Refactor gold file code
- Move source files into a test package that builds can be run against in new functional tests
- Update/simplify tool/update_gold_output_files.dart accordingly

Release Notes

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

Tests were updated and provide good coverage of the changeset and other affected code
Manual testing was performed if needed
- Steps from PR author:
  - All test cases from before are still captured
  - Tests run in CI and CI passes
- Anything falling under manual testing criteria outlined in CONTRIBUTING.md

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

A Frontend Frameworks Design member has reviewed these changes
There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
For release PRs - Version metadata in Rosie comment is correct

…sions We'll follow up by adding an integration test that runs the real builder

…cation

Copilot

Pull request overview

This PR migrates the over_react builder tests from unit tests to functional tests to address incompatibilities with newer analyzer versions. The refactoring moves source files into a dedicated test package and simplifies the gold file generation process, removing workarounds that were needed to support multiple analyzer versions.

Changes:

Migrated over_react_builder_test.dart from unit tests using build_test/build_resolvers to functional tests that run actual build_runner commands
Removed tool/update_tests_for_dart_3.sh and related multi-analyzer-version support code
Refactored gold file generation to use a test package at test_fixtures/test_packages/builder/ instead of copying files to a temporary directory

Reviewed changes

Copilot reviewed 26 out of 60 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
test/vm_tests/builder/over_react_builder_test.dart	Completely refactored to use functional tests with actual build_runner commands instead of unit tests with build_test
tool/update_gold_output_files.dart	Simplified to build the test package directly instead of copying files to a temporary directory
tool/update_tests_for_dart_3.sh	Removed as no longer needed with functional test approach
tool/update_tests_for_dart_3/build_test_3_updates.patch	Removed along with the script that applied it
test_fixtures/test_packages/builder/*	New test package structure with all source files for builder tests
test_fixtures/gold_output_files/*	Gold files updated with additional null safety comment lines in generated code
test_fixtures/gold_output_files/README.md	Simplified to remove instructions about restoring deleted files
.github/workflows/ci.yml	Removed calls to update_tests_for_dart_3.sh script

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-13T21:06:22Z

test/vm_tests/builder/over_react_builder_test.dart

+      Process.runSync('dart', ['pub', 'get'], workingDirectory: testPackagePath);
+      testPackageName =
+          RegExp('name: (.+)').firstMatch(File(p.join(testPackagePath, 'pubspec.yaml')).readAsStringSync())!.group(1)!;
+      outputDirectory = Directory.systemTemp.createTempSync().path;


The temporary directory created in setUpAll is never cleaned up. This will leak temporary directories on the filesystem every time tests run. Add a tearDownAll to clean up the temporary directory.

Copilot · 2026-02-13T21:06:22Z

tool/update_gold_output_files.dart

-  final buildProcess = await Process.start(
-      'dart', ['run', 'build_runner', 'build', '--build-filter=${p.join(tmpSourceDir.path, '**')}'],
-      mode: ProcessStartMode.inheritStdio);
+  print('Building files in test fixture ${goldsDir.path}');


The print message on this line says "Building files in test fixture ${goldsDir.path}", but goldsDir is the output directory for gold files, not the test fixture directory being built. This message should probably say something like "Updating gold files in ${goldsDir.path}" or refer to sourceFixtureDir instead.

Copilot · 2026-02-13T21:06:22Z

test/vm_tests/builder/over_react_builder_test.dart

-      expect(logs.where((log) => log.level >= Level.WARNING), isEmpty,
-        reason: 'Expected no logs at WARNING or SEVERE level, but got:\n'
-          '\t${logs.join('\n\t')}');
+    /// Runs build_runner for a specific file, cleaning first.


The comment says "Runs build_runner for a specific file, cleaning first" but the function does not perform any cleaning. The clean operation only happens once in setUpAll at line 35, not before each build. Update the comment to accurately reflect that this function builds without cleaning.

Suggested change

/// Runs build_runner for a specific file, cleaning first.

/// Runs build_runner for a specific file without cleaning.

Copilot · 2026-02-13T21:06:22Z

test/vm_tests/builder/over_react_builder_test.dart

+            '--build-filter=lib/${sourceFilePath.replaceAll('.dart', '*.g.dart')}',
+            '--output=$outputDirectory'
+          ],
+          workingDirectory: testPackagePath);
    }

-    Future<Null> checkBuildForFile(String assetPath, String expectedOutputAssetPath,
-        String pathToGoldFile) async {
-      final inputAsset = makeAssetId(assetPath);
+    String generatedOutputPath(String sourceFilePath) {
+      return p.join(
+        outputDirectory,
+        'packages',
+        testPackageName,
+        sourceFilePath.replaceAll('.dart', '.over_react.g.dart'),


Using replaceAll to change the file extension could cause issues if the file path contains '.dart' in places other than the extension (e.g., 'my.dart.file.dart' would become 'my.over_react.g.dart.file.over_react.g.dart'). Consider using a more robust approach like removing the extension with p.withoutExtension and then appending '.over_react.g.dart', or using a regex that only matches the extension at the end of the string.

robbecker-wf

I like the approach of moving to functional tests! LGTM

robbecker-wf · 2026-02-13T21:58:54Z

QA +1 CI passes with running the new tests

greglittlefield-wf · 2026-02-13T21:59:18Z

@Workiva/release-management-p

rmconsole-wf

+1 from RM

greglittlefield-wf added 3 commits February 10, 2026 17:22

Remove test that's difficult to author in multiple analyzer/build ver…

bdc6cb0

…sions We'll follow up by adding an integration test that runs the real builder

Migrate builder test to functional test, refactor gold source file lo…

e8ec471

…cation

Update gold files

84000e2

btr-rmconsole-6 bot added the Merge Requirements Unmet label Feb 11, 2026

greglittlefield-wf added the ignore release notes Suppresses the check-release-notes GHA check in PRs that shouldn't have release notes. label Feb 13, 2026

robbecker-wf requested a review from Copilot February 13, 2026 21:00

Copilot started reviewing on behalf of robbecker-wf February 13, 2026 21:00 View session

btr-rmconsole-1 bot changed the title ~~Migrate builder test to functional test, refactor gold file setup~~ FED-4419 Migrate builder test to functional test, refactor gold file setup Feb 13, 2026

Copilot AI reviewed Feb 13, 2026

View reviewed changes

greglittlefield-wf marked this pull request as ready for review February 13, 2026 21:14

greglittlefield-wf requested a review from robbecker-wf February 13, 2026 21:15

robbecker-wf approved these changes Feb 13, 2026

View reviewed changes

btr-rmconsole-6 bot added Merge Requirements Met and removed Merge Requirements Unmet labels Feb 13, 2026

btr-rmconsole-7 bot added the RM Ready label Feb 13, 2026

rmconsole-wf approved these changes Feb 13, 2026

View reviewed changes

btr-rmconsole-7 bot merged commit 16b9057 into master Feb 13, 2026
38 of 40 checks passed

btr-rmconsole-7 bot deleted the functional-builder-tests branch February 13, 2026 21:59

rmconsole-readonly-wk mentioned this pull request Feb 13, 2026

RM-373139 RM-373138 Release over_react 5.6.0 #1000

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FED-4419 Migrate builder test to functional test, refactor gold file setup#998

FED-4419 Migrate builder test to functional test, refactor gold file setup#998
btr-rmconsole-7[bot] merged 3 commits intomasterfrom
functional-builder-tests

greglittlefield-wf commented Feb 11, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

robbecker-wf left a comment

Uh oh!

robbecker-wf commented Feb 13, 2026

Uh oh!

greglittlefield-wf commented Feb 13, 2026

Uh oh!

rmconsole-wf left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	/// Runs build_runner for a specific file, cleaning first.
	/// Runs build_runner for a specific file without cleaning.

Conversation

greglittlefield-wf commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

Release Notes

Review

QA Checklist

Merge Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

robbecker-wf left a comment

Choose a reason for hiding this comment

Uh oh!

robbecker-wf commented Feb 13, 2026

Uh oh!

greglittlefield-wf commented Feb 13, 2026

Uh oh!

rmconsole-wf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

greglittlefield-wf commented Feb 11, 2026 •

edited

Loading